home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / shareware / intuition / reqtools_2.1e / readme < prev    next >
Text File  |  1994-11-17  |  42KB  |  785 lines
  1.  
  2.                       **********************************
  3.  
  4.                           reqtools.library
  5.  
  6.                           The requester toolkit.
  7.  
  8.                           Release 2.1e
  9.  
  10.                           (c) 1991-1993 Nico François
  11.  
  12.                       **********************************
  13.  
  14.  
  15.    First of all read the DISTRIBUTION file for information on... er well...
  16. distribution :-)
  17.  
  18.    If you have suggestions or remarks about ReqTools, or if you find any
  19. bugs, please let me know.
  20.  
  21.    Contacting the author:
  22.  
  23.      Fido:  2:292/603.10 (Nico Francois)
  24.  
  25.      UUCP:  Nico.Francois@p10.f603.n292.z2.FidoNet.Org
  26.  
  27.      Mail:  Nico François
  28.             Corbielaan 13
  29.             B-3060 Bertem
  30.             BELGIUM
  31.  
  32.    If you can please use e-mail.  That way you'll stand a much better chance
  33. of getting a reply quickly.
  34.  
  35.  
  36. Contents
  37. ========
  38.  
  39. 1. Introduction
  40.  
  41. 2. Features
  42.  
  43. 3. Installation
  44.  
  45. 4. Using reqtools.library
  46.  
  47.  
  48. 1. Introduction
  49. ===============
  50.  
  51.     reqtools.library is a standard Amiga shared, runtime library.  The purpose
  52. of ReqTools is to make it a lot quicker and easier to build standard requesters
  53. into your programs.  ReqTools is designed with Commodore's style guidelines in
  54. mind, all requesters have the look-and-feel of AmigaDOS Release 2.
  55.  
  56.     If you use ReqTools in your programs you do not have to worry about
  57. requesters too much.  You'll have a lot more time to concentrate on the
  58. really important stuff your program does.
  59.  
  60.     The library has been inspired by req.library (by Colin Fox & Bruce Dawson)
  61. and Commodore's own asl.library.  You will find it shares a lot of the
  62. features with these two libraries, while it has some additional ones as well.
  63. While asl.library was great in look-and-feel I felt it lacked quite a bit in
  64. the power department.  This power _is_ mostly available in req.library, but
  65. this doesn't fit in too well with AmigaDOS Release 2.  So the idea for a new
  66. requester library was born.
  67.  
  68.     I tried to make all requesters in ReqTools very powerful, easy to use and 
  69. with a very nice new-look 3D interface.  Efficiency was also considered very
  70. important.  The 2.0 version of the library is about 38K large.  I'm sure you
  71. will agree this is not too much considering what ReqTools offers.
  72.  
  73.     ReqTools features the following requesters:  a query requester, a string
  74. requester, a number requester, a file requester, a font requester, a palette
  75. requester and new in release 2.0 of ReqTools a volume requester and a screen
  76. mode requester.
  77.  
  78.  
  79. 2. Features
  80. ===========
  81.  
  82.    The requesters have following features (features marked with *NEW* are new
  83. features for release 2.0, version 38 of ReqTools).
  84.  
  85.    All requesters:
  86.  
  87.       o have a pixel-perfect Workbench 2.0 3D look, also on Kickstart 1.3.
  88. *NEW* o Completely localized!  If you are using Workbench 2.1 or higher the
  89.         text in ReqTools requesters will appear in the language of your
  90.         Workbench (if the catalog for this language is available).
  91.       o adjust to interlaced screens and to the screen's font (rtEZRequest,
  92.         rtGetLong, rtGetString) or to any fixed-width font if the screen's
  93.         font is proportional (rtPaletteRequest/rtFileRequest/rtFontRequest).
  94. *NEW*   Requesters can also use any suitable font you specify.
  95.       o can appear under the mouse pointer, centered on the
  96.         screen/in a window or at the top left of the screen/a window.
  97.       o can be used asynchronously.
  98.       o check pr_WindowPtr of your process is to find the screen they should
  99.         appear on (can be overridden).
  100.       o use tags for maximum future extendibility.  All standard 2.0 tags are
  101.         supported (like TAG_SKIP, TAG_MORE, etc.).
  102.       o bring the screen they appear on to the front.  The screen that was
  103.         in front previously will be put in front again when the requester
  104.         finishes (if it is still open).
  105. *NEW*   This behaviour can be switched off.
  106.       o will always appear in the visible portion of the screen (support of
  107.         virtual screens).
  108.       o are extensively tested using enforcer and mungwall debugging tools.
  109. *NEW* o have the ability to lock the parent window from all user input and
  110.         give it a standard wait pointer automatically.
  111. *NEW* o can share the IDCMP port of the parent window.
  112. *NEW* o supports a callback hook for handling IDCMP messages from a shared
  113.         IDCMP port.
  114. *NEW* o have keyboard shortcuts for gadgets (key underlined in gadget label).
  115.         Use Right Amiga key with shortcut if a string gadget is active.
  116.  
  117.    rtEZRequest, the query requester:
  118.  
  119.       o easy keyboard shortcuts:
  120.         - Left Amiga V and Left Amiga B (like the standard requesters).
  121.         - Y for positive response.
  122.         - N, R, Esc for negative response.
  123.         - Return can also be used as a shortcut and can be
  124.           associated with any response.  The gadget in question
  125.           will have its text printed bold.
  126.           Default response for Return is the positive response.
  127.         - buttons give visual feedback when keyboard shortcuts
  128.           are used.
  129.         - keyboard shortcuts can be canceled by pressing Shift
  130.           before releasing the key.
  131. *NEW*   - keyboard shortcuts can be defined to be any character in the
  132.           button's label.  The character in question will be underlined.
  133.       o number of responses only limited by screen width.
  134.       o allows for multiple lines of text.
  135.       o text can be centered in requester (great for about requesters).
  136.       o supports the use of 'printf' formatting codes in text
  137.         and in responses.
  138.       o can be terminated by IDCMP events.
  139.  
  140.    rtFileRequest, the file requester:
  141.  
  142.       o similar in use and look-and-feel as Asl file requester.
  143.       o buffers directories in memory.
  144.       o files and directories can be added or removed from the buffer
  145.         by the calling program.
  146.       o can be put in save mode, disabling double-clicks and asking you if
  147.         directories that can't be found (entered manually) should be created.
  148.       o optional callback hook for verification of files before they are
  149.         added to the buffer.
  150.       o supports multiple selection of files and optionally of directories.
  151.       o when multi-select is on All, Clear and Match.. buttons are available.
  152.         All selects, and Clear unselects all files.  Match.. brings up a
  153.         requester where the user can enter a pattern to select files.
  154.       o can be used as a directory requester (showing no files).
  155.       o optional pattern gadget to match files on.
  156.       o shows all devices (with volume names) and all assigns made.
  157.       o supports TABCYCLE under 2.0
  158.       o pattern matching supports _ALL_ AmigaDOS 2.0 patterns.
  159. *NEW* o can be used as a volume requester to get a device or an assign
  160.         from the user.
  161. *NEW* o can be resized in height to show more files.
  162. *NEW* o Shows disk percentage used next to volume names.
  163. *NEW* o Allows you to enter paths in the filename string gadget.  If the
  164.         requester finds a path in the filename it will change the directory
  165.         to that path.  So if you e.g. enter 'Devs:mountlist' in the filename
  166.         gadget the requester will read the 'Devs:' directory and set the
  167.         filename gadget to 'mountlist'.  If you enter 'printers/' it will go
  168.         into the printers directory. Enter '/' to go to the parent directory.
  169. *NEW* o Completely keyboard controlable: use up and down cursor keys to
  170.         select files or directories.  Use Shift-Up and Shift-Down to jump
  171.         by one window-full.  Use Ctrl-Up and Ctrl-Down to jump to the start
  172.         or end of the directory.
  173.  
  174.    rtFontRequest, the font requester:
  175.  
  176.       o buffers all fonts in memory.
  177.       o shows sample of font you click on.
  178.       o can be also be used to select the font's style.
  179.       o supports color fonts, can change the screen's palette.
  180.       o supports scaled fonts (AmigaOS Release 2 only).
  181.       o optional callback hook for verification of fonts before they are
  182.         added to the buffer.
  183.       o supports TABCYCLE under 2.0
  184. *NEW* o can be resized in height to show more fonts.
  185. *NEW* o makes sure selected font is visible in listview when it comes up.
  186.  
  187. *NEW* rtScreenModeRequest, the display mode requester (Kicks